Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec
The Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec schema defines the deployment parameters that can be specified for the deploy operation where the deployment target is a resource pool. See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy.
{
"name": "string",
"annotation": "string",
"accept_all_eula": false,
"network_mappings": {
"network_mappings": "string"
},
"storage_mappings": {
"storage_mappings": {
"type": "string",
"datastore_id": "string",
"storage_profile_id": "string",
"provisioning": "string"
}
},
"storage_provisioning": "string",
"storage_profile_id": "string",
"locale": "string",
"flags": [
"string"
],
"additional_parameters": [
{
"type": "string"
}
],
"default_datastore_id": "string",
"vm_config_spec": {
"provider": "string",
"xml": "string"
}
}Name assigned to the deployed target virtual machine or virtual appliance.
If missing or null, the server will use the name from the OVF package.
Annotation assigned to the deployed target virtual machine or virtual appliance.
If missing or null, the server will use the annotation from the OVF package.
Whether to accept all End User License Agreements. See Vcenter Ovf LibraryItem OvfSummary.EULAs.
Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the map is the section identifier of the ovf:NetworkSection section in the OVF descriptor and the value is the target network to be used for deployment.
If missing or null, the server will choose a network mapping.
When clients pass a value of this schema as a parameter, the value in the property map must be an identifier for the resource type: Network. When operations return a value of this schema as a response, the value in the property map will be an identifier for the resource type: Network.
Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the map is the section identifier of the ovf:StorageGroupSection section in the OVF descriptor and the value is the target storage specification to be used for deployment. See Vcenter Ovf LibraryItem StorageGroupMapping.
If missing or null, the server will choose a storage mapping.
Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor.
For more information see: Vcenter Ovf DiskProvisioningType.
If missing or null, the server will choose the provisioning type.
Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor.
If missing or null, the server will choose the default profile.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: StorageProfile. When operations return a value of this schema as a response, the property will be an identifier for the resource type: StorageProfile.
The locale to use for parsing the OVF descriptor.
If missing or null, the server locale will be used.
Flags to be use for deployment. The supported flag values can be obtained using GET /vcenter/ovf/import-flag.
If missing or null, no flags will be used.
Additional OVF parameters that may be needed for the deployment. Additional OVF parameters may be required by the OVF descriptor of the OVF package in the library item. Examples of OVF parameters that can be specified through this property include, but are not limited to:
- Vcenter Ovf DeploymentOptionParams
- Vcenter Ovf ExtraConfigParams
- Vcenter Ovf IpAllocationParams
- Vcenter Ovf PropertyParams
- Vcenter Ovf ScaleOutParams
- Vcenter Ovf VcenterExtensionParams
If missing or null, the server will choose default settings for all parameters necessary for the deploy operation. See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy.
When clients pass a value of this schema as a parameter, the property must contain all the properties defined in Vcenter Ovf OvfParams. When operations return a value of this schema as a response, the property will contain all the properties defined in Vcenter Ovf OvfParams.
Default datastore to use for all sections of type vmw:StorageSection in the OVF descriptor.
If missing or null, the server will choose the default datastore.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Datastore. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Datastore.
The Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.vm_config_spec is used for virtual machine configuration settings including hardware specifications to use in place of the OVF descriptor. If set, the OVF descriptor acts as a disk descriptor. Fields in the Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec parameters such as Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.name that overlap with settings in the Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.vm_config_spec are not overridden and will continue to be used. Similarly, storage settings in the Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec that affect the disks on the virtual machine namely Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.storage_mappings, Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.storage_profile_id, Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.storage_provisioning and Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.default_datastore_id will also be honored.
This property was added in vSphere API 8.0.2.0.
If missing or null, the relevant virtual machine specifications in the OVF descriptor of the OVF template will be used.